<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>S110_nRF51822/Include/ble/ble_sdk_util.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51822 BLE SDK
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('ble__sdk__util_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">S110_nRF51822/Include/ble/ble_sdk_util.h</div>  </div>
</div>
<div class="contents">
<a href="ble__sdk__util_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * The information contained herein is property of Nordic Semiconductor ASA.</span>
<a name="l00004"></a>00004 <span class="comment"> * Terms and conditions of usage are described in detail in NORDIC</span>
<a name="l00005"></a>00005 <span class="comment"> * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Licensees are granted free, non-transferable use of the information. NO</span>
<a name="l00008"></a>00008 <span class="comment"> * WARRANTY of ANY KIND is provided. This heading must NOT be removed from</span>
<a name="l00009"></a>00009 <span class="comment"> * the file.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * $LastChangedRevision$</span>
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef BLE_SDK_UTIL_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define BLE_SDK_UTIL_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &quot;compiler_abstraction.h&quot;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#define PACKED __packed</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00031"></a><a class="code" href="group__ble__sdk__lib__util.html#gaa6f104ea023a4a6a56ef05f30b0cfdc3">00031</a> <span class="keyword">typedef</span> uint8_t <a class="code" href="group__ble__sdk__lib__util.html#gaa6f104ea023a4a6a56ef05f30b0cfdc3" title="type for holding an encoded (i.e. little endian) 16 bit unsigned integer.">uint16_le_t</a>[2];
<a name="l00032"></a>00032 
<a name="l00034"></a><a class="code" href="group__ble__sdk__lib__util.html#ga634aa3136e273c2a368023ce97e73f01">00034</a> <span class="keyword">typedef</span> uint8_t <a class="code" href="group__ble__sdk__lib__util.html#ga634aa3136e273c2a368023ce97e73f01" title="type for holding an encoded (i.e. little endian) 32 bit unsigned integer.">uint32_le_t</a>[4];
<a name="l00035"></a>00035 
<a name="l00037"></a>00037 <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00038"></a>00038 {
<a name="l00039"></a><a class="code" href="structuint8__array__t.html#aaba88b24a21a6c70c895c0d55f4a69a0">00039</a>     uint16_t  <a class="code" href="structuint8__array__t.html#aaba88b24a21a6c70c895c0d55f4a69a0">size</a>;                 
<a name="l00040"></a><a class="code" href="structuint8__array__t.html#a8304c4af5da6e830b86d7199dc9a22e6">00040</a>     uint8_t * <a class="code" href="structuint8__array__t.html#a8304c4af5da6e830b86d7199dc9a22e6">p_data</a>;               
<a name="l00041"></a>00041 } <a class="code" href="structuint8__array__t.html" title="Byte array type.">uint8_array_t</a>;
<a name="l00042"></a>00042 
<a name="l00044"></a>00044 <span class="preprocessor">#define _GPIO_PIN_CONFIG(PIN_NO, IO_OUTPUT, IO_PULL, IO_DRIVE, IO_SENSE) \</span>
<a name="l00045"></a>00045 <span class="preprocessor">    do{                                                                  \</span>
<a name="l00046"></a>00046 <span class="preprocessor">        NRF_GPIO-&gt;PIN_CNF[##PIN_NO##] =                                  \</span>
<a name="l00047"></a>00047 <span class="preprocessor">            ((IO_OUTPUT) &lt;&lt; 0) |                                         \</span>
<a name="l00048"></a>00048 <span class="preprocessor">            ((IO_OUTPUT) &lt;&lt; 1) |                                         \</span>
<a name="l00049"></a>00049 <span class="preprocessor">            ((IO_PULL)   &lt;&lt; 2) |                                         \</span>
<a name="l00050"></a>00050 <span class="preprocessor">            ((IO_DRIVE)  &lt;&lt; 8) |                                         \</span>
<a name="l00051"></a>00051 <span class="preprocessor">            ((IO_SENSE)  &lt;&lt; 16);                                         \</span>
<a name="l00052"></a>00052 <span class="preprocessor">    } while(0)</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span>
<a name="l00065"></a><a class="code" href="group__ble__sdk__lib__util.html#ga6259b9f2ea4ab48312b1836c71f484bb">00065</a> <span class="preprocessor">#define GPIO_PIN_CONFIG(PIN_NO, IO_OUTPUT, IO_PULL, IO_DRIVE, IO_SENSE)\</span>
<a name="l00066"></a>00066 <span class="preprocessor">            _GPIO_PIN_CONFIG(PIN_NO, IO_OUTPUT, IO_PULL, IO_DRIVE, IO_SENSE)</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>
<a name="l00072"></a><a class="code" href="group__ble__sdk__lib__util.html#ga3f8d3d1b629cf9a61a86886059987e6a">00072</a> <span class="preprocessor">#define GPIO_LED_CONFIG(PIN_NO)                       \</span>
<a name="l00073"></a>00073 <span class="preprocessor">    do                                                \</span>
<a name="l00074"></a>00074 <span class="preprocessor">    {                                                 \</span>
<a name="l00075"></a>00075 <span class="preprocessor">        GPIO_PIN_CONFIG(PIN_NO,                       \</span>
<a name="l00076"></a>00076 <span class="preprocessor">                        GPIO_PIN_CNF_DIR_Output,      \</span>
<a name="l00077"></a>00077 <span class="preprocessor">                        GPIO_PIN_CNF_PULL_Disabled,   \</span>
<a name="l00078"></a>00078 <span class="preprocessor">                        GPIO_PIN_CNF_DRIVE_S0S1,      \</span>
<a name="l00079"></a>00079 <span class="preprocessor">                        GPIO_PIN_CNF_SENSE_Disabled); \</span>
<a name="l00080"></a>00080 <span class="preprocessor">    } while (0)</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span>
<a name="l00086"></a><a class="code" href="group__ble__sdk__lib__util.html#ga5f313d1d9c2c322ca6b265f597ab7c7d">00086</a> <span class="preprocessor">#define GPIO_DEBUG_PIN_CONFIG(PIN_NO)               \</span>
<a name="l00087"></a>00087 <span class="preprocessor">    do                                              \</span>
<a name="l00088"></a>00088 <span class="preprocessor">    {                                               \</span>
<a name="l00089"></a>00089 <span class="preprocessor">        GPIO_PIN_CONFIG(PIN_NO,                     \</span>
<a name="l00090"></a>00090 <span class="preprocessor">                      GPIO_PIN_CNF_DIR_Output,      \</span>
<a name="l00091"></a>00091 <span class="preprocessor">                      GPIO_PIN_CNF_PULL_Disabled,   \</span>
<a name="l00092"></a>00092 <span class="preprocessor">                      GPIO_PIN_CNF_DRIVE_S0S1,      \</span>
<a name="l00093"></a>00093 <span class="preprocessor">                      GPIO_PIN_CNF_SENSE_Disabled); \</span>
<a name="l00094"></a>00094 <span class="preprocessor">    } while (0)</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="preprocessor">#define _GPIOTE_BUTTON_CONFIG(PIN_NO)           \</span>
<a name="l00098"></a>00098 <span class="preprocessor">    (                                           \</span>
<a name="l00099"></a>00099 <span class="preprocessor">        (GPIOTE_CONFIG_POLARITY_HiToLo &lt;&lt; 16) | \</span>
<a name="l00100"></a>00100 <span class="preprocessor">        ((PIN_NO) &lt;&lt; 8) |                       \</span>
<a name="l00101"></a>00101 <span class="preprocessor">        GPIOTE_CONFIG_MODE_Event                \</span>
<a name="l00102"></a>00102 <span class="preprocessor">    )</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span>
<a name="l00109"></a><a class="code" href="group__ble__sdk__lib__util.html#gaf4e57e59f98b21778ea8f231423816fd">00109</a> <span class="preprocessor">#define GPIOTE_BUTTON_CONFIG(PIN_NO) _GPIOTE_BUTTON_CONFIG(PIN_NO)</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span>
<a name="l00112"></a><a class="code" href="group__ble__sdk__lib__util.html#ga61149a977f6ebdaeb8bdeed626dd9392">00112</a> <span class="preprocessor">#define CRITICAL_REGION_ENTER()                                                         \</span>
<a name="l00113"></a>00113 <span class="preprocessor">    {                                                                                   \</span>
<a name="l00114"></a>00114 <span class="preprocessor">        uint8_t IS_NESTED_CRITICAL_REGION;                                              \</span>
<a name="l00115"></a>00115 <span class="preprocessor">        uint32_t ERR_CODE = nrf_nvic_critical_region_enter(&amp;IS_NESTED_CRITICAL_REGION); \</span>
<a name="l00116"></a>00116 <span class="preprocessor">        if (ERR_CODE != NRF_SUCCESS)                                                    \</span>
<a name="l00117"></a>00117 <span class="preprocessor">        {                                                                               \</span>
<a name="l00118"></a>00118 <span class="preprocessor">            ASSERT(false);                                                              \</span>
<a name="l00119"></a>00119 <span class="preprocessor">        }                                                     </span>
<a name="l00120"></a>00120 <span class="preprocessor"></span>    
<a name="l00122"></a><a class="code" href="group__ble__sdk__lib__util.html#ga854878240b628e978f760f75aca4e1cc">00122</a> <span class="preprocessor">#define CRITICAL_REGION_EXIT()                                                          \</span>
<a name="l00123"></a>00123 <span class="preprocessor">        ERR_CODE = nrf_nvic_critical_region_exit(IS_NESTED_CRITICAL_REGION);            \</span>
<a name="l00124"></a>00124 <span class="preprocessor">        if (ERR_CODE != NRF_SUCCESS)                                                    \</span>
<a name="l00125"></a>00125 <span class="preprocessor">        {                                                                               \</span>
<a name="l00126"></a>00126 <span class="preprocessor">            ASSERT(false);                                                              \</span>
<a name="l00127"></a>00127 <span class="preprocessor">        }                                                                               \</span>
<a name="l00128"></a>00128 <span class="preprocessor">    }</span>
<a name="l00129"></a>00129 <span class="preprocessor"></span>    
<a name="l00136"></a><a class="code" href="group__ble__sdk__lib__util.html#ga25e8110559dbc9665dfb9485be8ac60f">00136</a> <span class="preprocessor">#define ROUNDED_DIV(A, B) (((A) + ((B) / 2)) / (B))</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span>
<a name="l00147"></a><a class="code" href="group__ble__sdk__lib__util.html#ga7aaa817cfd7ed354f09db5675ffe1427">00147</a> <span class="preprocessor">#define CEIL_DIV(A, B)      \</span>
<a name="l00148"></a>00148 <span class="preprocessor">    </span><span class="comment">/*lint -save -e573 */</span>   \
<a name="l00149"></a>00149     ((((A) - 1) / (B)) + 1) \
<a name="l00150"></a>00150     <span class="comment">/*lint -restore */</span>
<a name="l00151"></a>00151 
<a name="l00158"></a><a class="code" href="group__ble__sdk__lib__util.html#gab58c28346b89382397aa7a716bf9a178">00158</a> <span class="keyword">static</span> __INLINE uint8_t <a class="code" href="group__ble__sdk__lib__util.html#gab58c28346b89382397aa7a716bf9a178" title="Inline function for encoding a uint16 value.">uint16_encode</a>(uint16_t value, uint8_t * p_encoded_data)
<a name="l00159"></a>00159 {
<a name="l00160"></a>00160     *((PACKED uint16_t *)p_encoded_data) = value;
<a name="l00161"></a>00161     <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(PACKED uint16_t);
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163     
<a name="l00170"></a><a class="code" href="group__ble__sdk__lib__util.html#gad960286275534b81d75fbeba2d52aec9">00170</a> <span class="keyword">static</span> __INLINE uint8_t <a class="code" href="group__ble__sdk__lib__util.html#gad960286275534b81d75fbeba2d52aec9" title="Inline function for encoding a uint32 value.">uint32_encode</a>(uint32_t value, uint8_t * p_encoded_data)
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172     *((PACKED uint32_t *)p_encoded_data) = value;
<a name="l00173"></a>00173     <span class="keywordflow">return</span> <span class="keyword">sizeof</span>(PACKED uint32_t);
<a name="l00174"></a>00174 }
<a name="l00175"></a>00175 
<a name="l00181"></a><a class="code" href="group__ble__sdk__lib__util.html#gaf30655fd762a9debe0b499db3a9451f7">00181</a> <span class="keyword">static</span> __INLINE uint16_t <a class="code" href="group__ble__sdk__lib__util.html#gaf30655fd762a9debe0b499db3a9451f7" title="Inline function for decoding a uint16 value.">uint16_decode</a>(<span class="keyword">const</span> uint8_t * p_encoded_data)
<a name="l00182"></a>00182 {
<a name="l00183"></a>00183     <span class="keywordflow">return</span> *((PACKED uint16_t *)p_encoded_data);
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185 
<a name="l00191"></a><a class="code" href="group__ble__sdk__lib__util.html#gaa8eaa6f05cd43462e58a24e54c0ddacd">00191</a> <span class="keyword">static</span> __INLINE uint32_t <a class="code" href="group__ble__sdk__lib__util.html#gaa8eaa6f05cd43462e58a24e54c0ddacd" title="Inline function for decoding a uint32 value.">uint32_decode</a>(<span class="keyword">const</span> uint8_t * p_encoded_data)
<a name="l00192"></a>00192 {
<a name="l00193"></a>00193     <span class="keywordflow">return</span> *((PACKED uint32_t *)p_encoded_data);
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195     
<a name="l00196"></a>00196 <span class="preprocessor">#endif // BLE_SDK_UTIL_H__</span>
<a name="l00197"></a>00197 <span class="preprocessor"></span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="ble__sdk__util_8h.html">ble_sdk_util.h</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
